home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_leafnode.idb / usr / freeware / catman / a_man / cat8 / leafnode.Z / leafnode
Encoding:
Text File  |  1999-04-16  |  20.5 KB  |  529 lines

  1.  
  2.  
  3.  
  4.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       leafnode - NNTP server for small (dialup) sites
  10.  
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       lllleeeeaaaaffffnnnnooooddddeeee
  14.  
  15.  
  16.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.       LLLLeeeeaaaaffffnnnnooooddddeeee is a    USENET package intended    for small sites, where
  18.       there    are few    users and little disk space, but where a large
  19.       number of groups is desired.
  20.  
  21.       The design of    lllleeeeaaaaffffnnnnooooddddeeee is intended to    self-repair after
  22.       problems, and    to require no manual maintenance.
  23.  
  24.       The lllleeeeaaaaffffnnnnooooddddeeee program itself is the NNTP server.  It is run
  25.       from /_e_t_c/_i_n_e_t_d._c_o_n_f when someone wants to read news.     The
  26.       other    parts of the package, ffffeeeettttcccchhhh and    tttteeeexxxxppppiiiirrrreeee,,,, are
  27.       responsible for fetching new news from another server, and
  28.       for deleting old news.
  29.  
  30.  
  31.      AAAACCCCCCCCEEEESSSSSSSS CCCCOOOONNNNTTTTRRRROOOOLLLL
  32.       No authentication or access control is supported.  This is a
  33.       deliberate omission: Implementing this is a job which    should
  34.       not be redone    for each and every service.
  35.  
  36.       I recommend that either firewalling or tcpd be used for
  37.       access control.
  38.  
  39.  
  40.      FFFFIIIILLLLEEEESSSS
  41.       All these files and directories _m_u_s_t be writable by user
  42.       "news".
  43.  
  44.       /_u_s_r/_l_i_b/_l_e_a_f_n_o_d_e/_c_o_n_f_i_g contains the    configuration
  45.       parameters for lllleeeeaaaaffffnnnnooooddddeeee.... See CONFIGURATION below.
  46.  
  47.       /_v_a_r/_s_p_o_o_l/_n_e_w_s contains the news articles; e.g.
  48.       /_v_a_r/_s_p_o_o_l/_n_e_w_s/_a_l_t/_f_a_n/_a_g_u_l_b_r_a contains the articles    in the
  49.       _a_l_t._f_a_n._a_g_u_l_b_r_a group.  Each directory contains articles in
  50.       numbered files (decimal numbers, monotonically increasing),
  51.       and a    special    file called ._o_v_e_r_v_i_e_w which contains the
  52.       "Subject", "From", "Date", "Message-ID", "References",
  53.       "Bytes" and "Lines" headers for each article in the group.
  54.  
  55.       Several subdirectories are special:
  56.  
  57.       /_v_a_r/_s_p_o_o_l/_n_e_w_s/_l_e_a_f._n_o_d_e contains the files that leafnode
  58.       creates during operation, for    example    the ggggrrrroooouuuuppppiiiinnnnffffoooo file
  59.       which    contains information about each    USENET newsgroup. This
  60.  
  61.  
  62.  
  63.      Page 1                          (printed 3/1/99)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  71.  
  72.  
  73.  
  74.       file is built    by ffffeeeettttcccchhhh (8). You can force a complete rebuild
  75.       of the groupinfo file    by calling ffffeeeettttcccchhhh with the parameter -f
  76.       (see ffffeeeettttcccchhhh (8)).
  77.  
  78.       /_v_a_r/_s_p_o_o_l/_n_e_w_s/_o_u_t._g_o_i_n_g contains local postings that
  79.       ffffeeeettttcccchhhh(8) is to pass to the upstream NNTP server.
  80.  
  81.       /_v_a_r/_s_p_o_o_l/_n_e_w_s/_f_a_i_l_e_d._p_o_s_t_i_n_g_s contains local postings that
  82.       the upstream server rejected.     ffffeeeettttcccchhhh(8) will create files in
  83.       this directory, but none of the lllleeeeaaaaffffnnnnooooddddeeee programs will
  84.       delete anything in it.
  85.  
  86.       /_v_a_r/_s_p_o_o_l/_n_e_w_s/_m_e_s_s_a_g_e._i_d contains hard links to each
  87.       message; this    is used    in place of the    ddddbbbbzzzz database typically
  88.       used by bigger servers.  (A directory    such as    this is
  89.       probably more    efficient for the small    servers    lllleeeeaaaaffffnnnnooooddddeeee is
  90.       designed for but scales very badly.)
  91.  
  92.       /_v_a_r/_s_p_o_o_l/_n_e_w_s/_i_n_t_e_r_e_s_t_i_n_g._g_r_o_u_p_s contains one file for
  93.       each group an    NNTP client has    asked to read.    lllleeeeaaaaffffnnnnooooddddeeee will
  94.       touch    the the    relevant file when a LISTGROUP,    XOVER, XHDR,
  95.       STAT,    HEAD, BODY or ARTICLE command is issued    immediately
  96.       after    a GROUP    command    is issued, and ffffeeeettttcccchhhh(8)    will retrieve
  97.       all new articles in all groups whose files have been either
  98.  
  99.            - touched during    the past two days, or
  100.  
  101.            - touched more than once, and at    least once within the
  102.            past week.
  103.  
  104.       /_e_t_c/_i_n_e_t_d._c_o_n_f contains the line which starts lllleeeeaaaaffffnnnnooooddddeeee.... It
  105.       is strongly recommended to start lllleeeeaaaaffffnnnnooooddddeeee as user news.
  106.  
  107.  
  108.      CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
  109.       All configuration is done using the file
  110.       /_u_s_r/_l_i_b/_l_e_a_f_n_o_d_e/_c_o_n_f_i_g. There is no    GUI configuration tool
  111.       yet.
  112.  
  113.       The file has a rather    standard Unix format: one line per
  114.       argument, comments are introduced by a hash mark (#) and
  115.       last until the end of    the line. Below    are examples on    how
  116.       the various parameters are specified.
  117.  
  118.       MMMMAAAANNNNDDDDAAAATTTTOOOORRRRYYYY PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  119.  
  120.       server = news02.bigprovider.com
  121.            "server"    is used    by ffffeeeettttcccchhhh (8) to    select what NNTP
  122.            server to retrieve news from and    to post    your articles
  123.            to (the primary news server). You need read and post
  124.            access to it.  In the example above,
  125.            news02.bigprovider.com is the primary news server.
  126.  
  127.  
  128.  
  129.      Page 2                          (printed 3/1/99)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  137.  
  138.  
  139.  
  140.       expire = 5
  141.            "expire"    is the number of days a    thread should be kept
  142.            around. In the example, five days after the thread has
  143.            last been read, it is deleted by    tttteeeexxxxppppiiiirrrreeee    (8).
  144.  
  145.       SSSSEEEERRRRVVVVEEEERRRR----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNAAAALLLL PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  146.  
  147.       supplement = sex.and.warez.com
  148.            You can specify supplementary news servers, and
  149.            leafnode    will try to read news from them    in addition to
  150.            the primary server. It is possible to define more than
  151.            one supplementary server. If the    supplementary server
  152.            allows posting, then your articles will also be posted
  153.            through it.
  154.  
  155.       username = myname
  156.            If any of your news servers requires authentification,
  157.            you can enter your username on that server here.    This
  158.            field may occur multiple    times, once after each server
  159.            definition.
  160.  
  161.       password = mypassword
  162.            If any of your news servers requires authentification,
  163.            you can enter your password on that server here.    This
  164.            field may occur multiple    times, once after each server
  165.            definition.  Since the password is available in clear
  166.            text, it    is recommended that you    set the    rights on the
  167.            config file as restrictive as possible, otherwise other
  168.            users of    your computer will be able to get your
  169.            password(s) from    that file.
  170.  
  171.       timeout = 30
  172.            By default, leafnode tries to connect for 10 seconds to
  173.            a server    and then gives up. If you have a slow server,
  174.            you can try for a longer    time by    setting    the timeout
  175.            higher (in this example,    30 seconds). The timeout can
  176.            be tuned    individually for each server.
  177.  
  178.       nodesc = 1
  179.            Some servers do not deliver news    groups descriptions
  180.            correctly because they cannot parse the LIST NEWSGROUPS
  181.            command.    In that    case, put this line after the
  182.            "server"/"supplement" line.
  183.  
  184.       port = 8000
  185.            By default, leafnode tries to connect to    its upstream
  186.            news servers on the NNTP    port (119). If your servers
  187.            run on a    different port,    you can    specify    those here.
  188.            This field may occur multiple times, once after each
  189.            server definition.
  190.  
  191.            GGGGEEEENNNNEEEERRRRAAAALLLL OOOOPPPPTTTTIIIIOOOONNNNAAAALLLL    PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  192.  
  193.  
  194.  
  195.      Page 3                          (printed 3/1/99)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  203.  
  204.  
  205.  
  206.  
  207.  
  208.       hostname = host.domain.country
  209.            By default, Leafnode tries to generate the message ID
  210.            of outgoing messages from the name of your computer.
  211.            However,    some upstream servers demand message IDs of a
  212.            certain type. In    this case, you can override the    name
  213.            of your computer    by setting "hostname" to a sensible
  214.            value. The use of "hostname" to create fancy message
  215.            IDs is possible,    but strongly discouraged.
  216.  
  217.       create_all_links = 1
  218.            Normally, fetch will store articles only    in the
  219.            newsgroups which    you consider interesting. If you set
  220.            "create_all_links", fetch will create hardlinks for all
  221.            newsgroups which    it can find in the Newsgroups: header.
  222.            This may    be of interest if you want to apply a score-
  223.            or killfile to the Xref:    line.
  224.  
  225.       maxfetch = 1000
  226.            "maxfetch" specifies the    maximum    number of articles
  227.            ffffeeeettttcccchhhh (8) should    fetch from the upstream    server in each
  228.            group. Its use is not advised, because if you use it
  229.            you will    not see    all the    traffic    in a group. By default
  230.            there is    no limit.
  231.  
  232.       initialfetch = 1
  233.            "initialfetch" defines how many articles    from a newly
  234.            subscribed group    should be fetched. The default is to
  235.            fetch all old articles, which can get quite time-
  236.            consuming when subscribing to a very busy group.    This
  237.            is equivalent to    setting    initialfetch to    zero. If you
  238.            want to get no old articles when    subscribing to a new
  239.            group, you should set initialfetch to one, as in    the
  240.            example above.
  241.  
  242.       groupexpire very.crowded.group = 1
  243.  
  244.       groupexpire very.crowded.hierarchy.* = 1
  245.            "groupexpire" makes it possible to adjust expiry    times
  246.            for individual groups. Expiry times are given in    days.
  247.            This value is used by tttteeeexxxxppppiiiirrrreeee (8). You can specify as
  248.            many groupexpire    lines as you like. It is possible to
  249.            specify gggglllloooobbbb (7)-like wildcard expressions.
  250.  
  251.       maxage = 10
  252.            If an article turns up on your upstream news server
  253.            which is    older than "maxage" days it will not been
  254.            fetched even if you don't have it yet.  This is useful
  255.            if your upstream    server gets occasional "hiccups". The
  256.            default is set to 10. If    you want to switch this
  257.            feature off, set    maxage to some very large value, such
  258.  
  259.  
  260.  
  261.      Page 4                          (printed 3/1/99)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  269.  
  270.  
  271.  
  272.            as 100000 (this is equivalent to    roughly    270 years).
  273.  
  274.       maxlines = 2000
  275.            If you want to avoid receiving very large articles, you
  276.            may set the "maxlines" parameter    to the maximal number
  277.            of lines    an article should have.    By default, this
  278.            feature is switched off.
  279.  
  280.       minlines = 2
  281.            Sometimes newsgroups are    spammed    with empty postings.
  282.            To reject these postings, you can set the "minlines"
  283.            parameter. Setting minlines to a    value larger 4 is
  284.            probably    not a good idea    since you will also start to
  285.            kill "real" postings then. By default, this feature is
  286.            switched    off.
  287.  
  288.       maxbytes = 100000
  289.            If you want to avoid receiving very large articles,
  290.            instead of using    the "maxlines" parameter you can also
  291.            use the "maxbytes" parameter. By    default, this feature
  292.            is switched off.
  293.  
  294.       maxcrosspost = 5
  295.            If you want to combat spam, you can filter out all
  296.            postings    that are posted    to more    than a certain number
  297.            of newsgroups. The number is defined by setting
  298.            "maxcrosspost". Setting this parameter to very low
  299.            values is probably a bad    idea. This feature is switched
  300.            off by default.
  301.  
  302.       filterfile = /usr/lib/leafnode/filters
  303.            Leafnode    can filter the input headers for arbitrary
  304.            regular expressions.  These are stored in a file
  305.            designated "filterfile".    The format of "filterfile" is
  306.            very simple, one    regular    expression per line. If    one of
  307.            the regular expressions fits to a header    to be
  308.            downloaded, the body of that article will be rejected.
  309.            This feature is switched    off by default.
  310.  
  311.       timeout_short    = 2
  312.            By default, a group that    has been accidentally touched
  313.            is being    fetched    for two    days. You can change this time
  314.            by changing timeout_short.
  315.  
  316.       timeout_long = 7
  317.            By default, a group that    has not    been read at all is
  318.            being fetched for seven days before being unsubscribed.
  319.            This interval can be changed by setting timeout_long to
  320.            a different value.
  321.  
  322.       timeout_active = 90
  323.            By default, active files    from the upstream servers are
  324.  
  325.  
  326.  
  327.      Page 5                          (printed 3/1/99)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  335.  
  336.  
  337.  
  338.            re-read every 90    days. This interval can    be changed by
  339.            setting timeout_active to a different value. Be aware
  340.            that reading an active file transfers about one MB of
  341.            information if the server that you are using carries a
  342.            reasonable number of groups (i.e. around    20000).
  343.  
  344.       delaybody = 1
  345.            With this option    set, ffffeeeettttcccchhhh (8) fetches only the
  346.            headers of an article for visual    inspection. Only when
  347.            the headers have    been read, the bodies of the articles
  348.            will be retrieved the next time ffffeeeettttcccchhhh (8) is called.
  349.            This can    save a huge amount of download time and    disk
  350.            space.
  351.  
  352.       debugmode = 1
  353.            With this option    set, ffffeeeettttcccchhhh (8),    tttteeeexxxxppppiiiirrrreeee    (8) and
  354.            lllleeeeaaaaffffnnnnooooddddeeee    (8) will start to log lots of debugging    output
  355.            via ssssyyyysssslllloooogggg (8) to news.debug. Use it for    tracking down
  356.            problems    with your feed.
  357.  
  358.  
  359.      PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL
  360.       Here are the NNTP commands supported by this server.
  361.  
  362.       AAAARRRRTTTTIIIICCCCLLLLEEEE
  363.            Return the headers and body text    of an article.
  364.            LLLLeeeeaaaaffffnnnnooooddddeeee    supports this imperfectly; the message-id and
  365.            article number of the article may not be    reported in
  366.            the reply line.    This does not affect any tested    NNTP
  367.            clients.
  368.  
  369.       BBBBOOOODDDDYYYY Return the body text of an article.  See    AAAARRRRTTTTIIIICCCCLLLLEEEE....
  370.  
  371.       GGGGRRRROOOOUUUUPPPP
  372.            Sets the    current    USENET group and article pointer, and
  373.            returns the status information about this group.
  374.  
  375.       HHHHEEEEAAAADDDD Return the headers of an    article.  See AAAARRRRTTTTIIIICCCCLLLLEEEE....
  376.  
  377.       HHHHEEEELLLLPPPP Accepted    but I'm    afraid it is not very helpful.
  378.  
  379.       IIIIHHHHAAAAVVVVEEEE
  380.            Known but rejected.  See    ffffeeeettttcccchhhh(8).
  381.  
  382.       LLLLAAAASSSSTTTT Moves the article pointer back by 1.
  383.  
  384.       LLLLIIIISSSSTTTT Lists the available USENET groups.
  385.  
  386.       LLLLIIIISSSSTTTT OOOOVVVVEEEERRRRVVVVIIIIEEEEWWWW....FFFFMMMMTTTT
  387.            List some extensions.
  388.  
  389.       LLLLIIIISSSSTTTTGGGGRRRROOOOUUUUPPPP
  390.  
  391.  
  392.  
  393.      Page 6                          (printed 3/1/99)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  401.  
  402.  
  403.  
  404.            Lists the articles present in the current group,    or the
  405.            argument    group if an argument is    present.
  406.  
  407.       MMMMOOOODDDDEEEE Accepted    and blithely ignored.
  408.  
  409.       NNNNEEEEWWWWGGGGRRRROOOOUUUUPPPPSSSS
  410.            Lists newsgroups    which have been    newly created.
  411.  
  412.       NNNNEEEEWWWWNNNNEEEEWWWWSSSS
  413.            Accepted    but the    reply is always    empty.    This command
  414.            does not    make sense for this server.
  415.  
  416.       NNNNEEEEXXXXTTTT Moves the article pointer forward by 1.
  417.  
  418.       PPPPOOOOSSSSTTTT Post a new article.  Only scant syntax checking is
  419.            performed.  The article is sent to the upstream NNTP
  420.            server by ffffeeeettttcccchhhh(8).
  421.  
  422.       QQQQUUUUIIIITTTT Quit reading news.
  423.  
  424.       SSSSLLLLAAAAVVVVEEEE
  425.            Accepted    but ignored.
  426.  
  427.       SSSSTTTTAAAATTTT Return the availability of an article.  See AAAARRRRTTTTIIIICCCCLLLLEEEE....
  428.  
  429.       XXXXHHHHDDDDRRRR Accepted, but supported only for    the "Subject", "From",
  430.            "Date", "Message-ID", "References", "Bytes" and "Lines"
  431.            headers.
  432.  
  433.       XXXXOOOOVVVVEEEERRRR
  434.            Returns the "Subject", "From", "Date", "Message-ID",
  435.            "References", "Bytes" and "Lines" headers for the
  436.            indicated article(s).
  437.  
  438.  
  439.       The rest of the commands given in the    NNTP RFC or added in
  440.       other    servers    are left out in    order to keep the server
  441.       simple and bug-free.
  442.  
  443.  
  444.      BBBBUUUUGGGGSSSS
  445.       None known.
  446.  
  447.  
  448.      AAAAUUUUTTTTHHHHOOOORRRR
  449.       Written by Arnt Gulbrandsen <agulbra@troll.no> and copyright
  450.       1995 Troll Tech AS, Postboks 6133 Etterstad, 0602 Oslo,
  451.       Norway, fax +47 22646949.
  452.  
  453.       Modified by Cornelius    Krasel <krasel@wpxx02.toxi.uni-
  454.       wuerzburg.de>, Randolf Skerka    <Randolf.Skerka@gmx.de>    and
  455.       Markus Enzenberger <enz@cip.physik.uni-muenchen.de>.
  456.  
  457.  
  458.  
  459.      Page 7                          (printed 3/1/99)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      lllleeeeaaaaffffnnnnooooddddeeee((((8888))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 NNNNoooovvvv 1111999999998888))))       lllleeeeaaaaffffnnnnooooddddeeee((((8888))))
  467.  
  468.  
  469.  
  470.       Copyright of the modifications 1997-1999.
  471.  
  472.       The initial development of lllleeeeaaaaffffnnnnooooddddeeee has been paid for    by
  473.       Uninett AS (http://www.uninett.no/).
  474.  
  475.  
  476.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  477.       ttttccccppppdddd(8), hhhhoooossssttttssss....aaaalllllllloooowwww(5), ffffeeeettttcccchhhh(8), tttteeeexxxxppppiiiirrrreeee(8),
  478.       cccchhhheeeecccckkkkggggrrrroooouuuuppppssss(8), gggglllloooobbbb((((7777)))),,,, RRRRFFFFCCCC 999977777777
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.      Page 8                          (printed 3/1/99)
  526.  
  527.  
  528.  
  529.